Blame - docs/dyn/servicemanagement_v1.services.html - platform/external/python/google-api-python-client

"sourceContext": { # `SourceContext` represents information about the source of a # Source context for the protocol buffer service represented by this

1407

# message.

1408

# protobuf element, like the file in which it is defined.

1409

"fileName": "A String", # The path-qualified name of the .proto file that contained the associated

1410

# protobuf element. For example: `"google/protobuf/source_context.proto"`.

1411

},

1412

"mixins": [ # Included APIs. See Mixin.

1413

{ # Declares an API to be included in this API. The including API must

1414

# redeclare all the methods from the included API, but documentation

1415

# and options are inherited as follows:

1416

#

1417

# - If after comment and whitespace stripping, the documentation

1418

# string of the redeclared method is empty, it will be inherited

1419

# from the original method.

1420

#

1421

# - Each annotation belonging to the service config (http,

1422

# visibility) which is not set in the redeclared method will be

1423

# inherited.

1424

#

1425

# - If an http annotation is inherited, the path pattern will be

1426

# modified as follows. Any version prefix will be replaced by the

1427

# version of the including API plus the root path if specified.

1428

#

1429

# Example of a simple mixin:

1430

#

1431

# package google.acl.v1;

1432

# service AccessControl {

1433

# // Get the underlying ACL object.

1434

# rpc GetAcl(GetAclRequest) returns (Acl) {

1435

# option (google.api.http).get = "/v1/{resource=**}:getAcl";

# }

# }

#

# package google.storage.v2;

1440

# service Storage {

1441

# // rpc GetAcl(GetAclRequest) returns (Acl);

1442

#

1443

# // Get a data record.

1444

# rpc GetData(GetDataRequest) returns (Data) {

1445

# option (google.api.http).get = "/v2/{resource=**}";

# }

# }

#

# Example of a mixin configuration:

1450

#

1451

# apis:

1452

# - name: google.storage.v2.Storage

1453

# mixins:

1454

# - name: google.acl.v1.AccessControl

1455

#

1456

# The mixin construct implies that all methods in `AccessControl` are

1457

# also declared with same name and request/response types in

1458

# `Storage`. A documentation generator or annotation processor will

1459

# see the effective `Storage.GetAcl` method after inherting

1460

# documentation and annotations as follows:

1461

#

1462

# service Storage {

1463

# // Get the underlying ACL object.

1464

# rpc GetAcl(GetAclRequest) returns (Acl) {

1465

# option (google.api.http).get = "/v2/{resource=**}:getAcl";

# }

# ...

# }

#

# Note how the version in the path pattern changed from `v1` to `v2`.

1471

#

1472

# If the `root` field in the mixin is specified, it should be a

1473

# relative path under which inherited HTTP paths are placed. Example:

1474

#

1475

# apis:

1476

# - name: google.storage.v2.Storage

1477

# mixins:

1478

# - name: google.acl.v1.AccessControl

1479

# root: acls

1480

#

1481

# This implies the following inherited HTTP annotation:

1482

#

1483

# service Storage {

1484

# // Get the underlying ACL object.

1485

# rpc GetAcl(GetAclRequest) returns (Acl) {

1486

# option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";

# }

# ...

# }

"root": "A String", # If non-empty specifies a path under which inherited HTTP paths

1491

# are rooted.

1492

"name": "A String", # The fully qualified name of the API which is included.

1493

},

1494

],

1495

"syntax": "A String", # The source syntax of the service.

1496

"version": "A String", # A version string for this api. If specified, must have the form

1497

# `major-version.minor-version`, as in `1.10`. If the minor version

1498

# is omitted, it defaults to zero. If the entire version field is

1499

# empty, the major version is derived from the package name, as

1500

# outlined below. If the field is not empty, the version in the

1501

# package name will be verified to be consistent with what is

1502

# provided here.

1503

#

1504

# The versioning schema uses [semantic

1505

# versioning](http://semver.org) where the major version number

1506

# indicates a breaking change and the minor version an additive,

1507

# non-breaking change. Both version numbers are signals to users

1508

# what to expect from different versions, and should be carefully

1509

# chosen based on the product plan.

1510

#

1511

# The major version is also reflected in the package name of the

1512

# API, which must end in `v<major-version>`, as in

1513

# `google.feature.v1`. For major versions 0 and 1, the suffix can

1514

# be omitted. Zero major versions must only be used for

1515

# experimental, none-GA apis.

1516

"options": [ # Any metadata attached to the API.

1517

{ # A protocol buffer option, which can be attached to a message, field,

1518

# enumeration, etc.

1519

"name": "A String", # The option's name. For example, `"java_package"`.

1520

"value": { # The option's value. For example, `"com.google.protobuf"`.

1521

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

},

],

"name": "A String", # The fully qualified name of this api, including package name

1526

# followed by the api's simple name.

1527

},

1528

],

1529

"customError": { # Customize service error responses. For example, list any service # Custom error configuration.

1530

# specific protobuf types that can appear in error detail lists of

# error responses.

#

# Example:

#

# custom_error:

# types:

# - google.foo.v1.CustomError

1538

# - google.foo.v1.AnotherError

1539

"rules": [ # The list of custom error rules that apply to individual API messages.

1540

#

1541

# **NOTE:** All service configuration rules follow "last one wins" order.

1542

{ # A custom error rule.

1543

"isErrorType": True or False, # Mark this message as possible payload in error response. Otherwise,

1544

# objects of this type will be filtered when they appear in error payload.

1545

"selector": "A String", # Selects messages to which this rule applies.

1546

#

1547

# Refer to selector for syntax details.

1548

},

1549

],

1550

"types": [ # The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.

"A String",

],

},

"visibility": { # `Visibility` defines restrictions for the visibility of service # API visibility configuration.

1555

# elements. Restrictions are specified using visibility labels

1556

# (e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.

1557

#

1558

# Users and projects can have access to more than one visibility label. The

1559

# effective visibility for multiple labels is the union of each label's

1560

# elements, plus any unrestricted elements.

1561

#

1562

# If an element and its parents have no restrictions, visibility is

1563

# unconditionally granted.

#

# Example:

#

# visibility:

# rules:

# - selector: google.calendar.Calendar.EnhancedSearch

1570

# restriction: TRUSTED_TESTER

1571

# - selector: google.calendar.Calendar.Delegate

1572

# restriction: GOOGLE_INTERNAL

1573

#

1574

# Here, all methods are publicly visible except for the restricted methods

1575

# EnhancedSearch and Delegate.

1576

"rules": [ # A list of visibility rules that apply to individual API elements.

1577

#

1578

# **NOTE:** All service configuration rules follow "last one wins" order.

1579

{ # A visibility rule provides visibility configuration for an individual API

1580

# element.

1581

"restriction": "A String", # Lists the visibility labels for this rule. Any of the listed labels grants

1582

# visibility to the element.

1583

#

1584

# If a rule has multiple labels, removing one of the labels but not all of

1585

# them can break clients.

#

# Example:

#

# visibility:

# rules:

# - selector: google.calendar.Calendar.EnhancedSearch

1592

# restriction: GOOGLE_INTERNAL, TRUSTED_TESTER

1593

#

1594

# Removing GOOGLE_INTERNAL from this restriction will break clients that

1595

# rely on this method and only had access to it through GOOGLE_INTERNAL.

1596

"selector": "A String", # Selects methods, messages, fields, enums, etc. to which this rule applies.

1597

#

1598

# Refer to selector for syntax details.

},

],

},

"metrics": [ # Defines the metrics used by this service.

1603

{ # Defines a metric type and its schema.

1604

"displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces.

1605

# Use sentence case without an ending period, for example "Request count".

1606

"description": "A String", # A detailed description of the metric, which can be used in documentation.

1607

"metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.

1608

"valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.

1609

"labels": [ # The set of labels that can be used to describe a specific instance of this

1610

# metric type. For example, the

1611

# `compute.googleapis.com/instance/network/received_bytes_count` metric type

1612

# has a label, `loadbalanced`, that specifies whether the traffic was

1613

# received through a load balanced IP address.

1614

{ # A description of a label.

1615

"valueType": "A String", # The type of data that can be assigned to the label.

1616

"description": "A String", # A human-readable description for the label.

1617

"key": "A String", # The label key.

1618

},

1619

],

1620

"type": "A String", # The metric type including a DNS name prefix, for example

1621

# `"compute.googleapis.com/instance/cpu/utilization"`. Metric types

1622

# should use a natural hierarchical grouping such as the following:

1623

#

1624

# compute.googleapis.com/instance/cpu/utilization

1625

# compute.googleapis.com/instance/disk/read_ops_count

1626

# compute.googleapis.com/instance/network/received_bytes_count

1627

#

1628

# Note that if the metric type changes, the monitoring data will be

1629

# discontinued, and anything depends on it will break, such as monitoring

1630

# dashboards, alerting rules and quota limits. Therefore, once a metric has

1631

# been published, its type should be immutable.

1632

"unit": "A String", # The unit in which the metric value is reported. It is only applicable

1633

# if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The

1634

# supported units are a subset of [The Unified Code for Units of

1635

# Measure](http://unitsofmeasure.org/ucum.html) standard:

1636

#

1637

# **Basic units (UNIT)**

#

# * `bit` bit

# * `By` byte

# * `s` second

# * `min` minute

# * `h` hour

# * `d` day

#

# **Prefixes (PREFIX)**

#

# * `k` kilo (10**3)

# * `M` mega (10**6)

# * `G` giga (10**9)

# * `T` tera (10**12)

1652

# * `P` peta (10**15)

1653

# * `E` exa (10**18)

1654

# * `Z` zetta (10**21)

1655

# * `Y` yotta (10**24)

1656

# * `m` milli (10**-3)

1657

# * `u` micro (10**-6)

1658

# * `n` nano (10**-9)

1659

# * `p` pico (10**-12)

1660

# * `f` femto (10**-15)

1661

# * `a` atto (10**-18)

1662

# * `z` zepto (10**-21)

1663

# * `y` yocto (10**-24)

1664

# * `Ki` kibi (2**10)

1665

# * `Mi` mebi (2**20)

1666

# * `Gi` gibi (2**30)

1667

# * `Ti` tebi (2**40)

#

# **Grammar**

#

# The grammar includes the dimensionless unit `1`, such as `1/s`.

1672

#

1673

# The grammar also includes these connectors:

1674

#

1675

# * `/` division (as an infix operator, e.g. `1/s`).

1676

# * `.` multiplication (as an infix operator, e.g. `GBy.d`)

1677

#

1678

# The grammar for a unit is as follows:

1679

#

1680

# Expression = Component { "." Component } { "/" Component } ;

1681

#

1682

# Component = [ PREFIX ] UNIT [ Annotation ]

# | Annotation

# | "1"

# ;

#

# Annotation = "{" NAME "}" ;

#

# Notes:

#

# * `Annotation` is just a comment if it follows a `UNIT` and is

1692

# equivalent to `1` if it is used alone. For examples,

1693

# `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.

1694

# * `NAME` is a sequence of non-blank printable ASCII characters not

1695

# containing '{' or '}'.

1696

"name": "A String", # Resource name. The format of the name may vary between different

1697

# implementations. For examples:

1698

#

1699

# projects/{project_id}/metricDescriptors/{type=**}

1700

# metricDescriptors/{type=**}

1701

},

1702

],

1703

"enums": [ # A list of all enum types included in this API service. Enums

1704

# referenced directly or indirectly by the `apis` are automatically

1705

# included. Enums which are not referenced but shall be included

1706

# should be listed here by name. Example:

1707

#

1708

# enums:

1709

# - name: google.someapi.v1.SomeEnum

1710

{ # Enum type definition.

1711

"sourceContext": { # `SourceContext` represents information about the source of a # The source context.

1712

# protobuf element, like the file in which it is defined.

1713

"fileName": "A String", # The path-qualified name of the .proto file that contained the associated

1714

# protobuf element. For example: `"google/protobuf/source_context.proto"`.

1715

},

1716

"enumvalue": [ # Enum value definitions.

1717

{ # Enum value definition.

1718

"number": 42, # Enum value number.

1719

"options": [ # Protocol buffer options.

1720

{ # A protocol buffer option, which can be attached to a message, field,

1721

# enumeration, etc.

1722

"name": "A String", # The option's name. For example, `"java_package"`.

1723

"value": { # The option's value. For example, `"com.google.protobuf"`.

1724

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

},

],

"name": "A String", # Enum value name.

1729

},

1730

],

1731

"options": [ # Protocol buffer options.

1732

{ # A protocol buffer option, which can be attached to a message, field,

1733

# enumeration, etc.

1734

"name": "A String", # The option's name. For example, `"java_package"`.

1735

"value": { # The option's value. For example, `"com.google.protobuf"`.

1736

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

},

],

"name": "A String", # Enum type name.

1741

"syntax": "A String", # The source syntax.

1742

},

1743

],

1744

"types": [ # A list of all proto message types included in this API service.

1745

# Types referenced directly or indirectly by the `apis` are

1746

# automatically included. Messages which are not referenced but

1747

# shall be included, such as types used by the `google.protobuf.Any` type,

1748

# should be listed here by name. Example:

1749

#

1750

# types:

1751

# - name: google.protobuf.Int32

1752

{ # A protocol buffer message type.

1753

"oneofs": [ # The list of types appearing in `oneof` definitions in this type.

1754

"A String",

1755

],

1756

"name": "A String", # The fully qualified message name.

1757

"sourceContext": { # `SourceContext` represents information about the source of a # The source context.

1758

# protobuf element, like the file in which it is defined.

1759

"fileName": "A String", # The path-qualified name of the .proto file that contained the associated

1760

# protobuf element. For example: `"google/protobuf/source_context.proto"`.

1761

},

1762

"syntax": "A String", # The source syntax.

1763

"fields": [ # The list of fields.

1764

{ # A single field of a message type.

1765

"kind": "A String", # The field type.

1766

"oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration

1767

# types. The first type has index 1; zero means the type is not in the list.

1768

"typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration

1769

# types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.

1770

"name": "A String", # The field name.

1771

"defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.

1772

"jsonName": "A String", # The field JSON name.

1773

"number": 42, # The field number.

1774

"cardinality": "A String", # The field cardinality.

1775

"options": [ # The protocol buffer options.

1776

{ # A protocol buffer option, which can be attached to a message, field,

1777

# enumeration, etc.

1778

"name": "A String", # The option's name. For example, `"java_package"`.

1779

"value": { # The option's value. For example, `"com.google.protobuf"`.

1780

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

},

],

"packed": True or False, # Whether to use alternative packed wire representation.

1785

},

1786

],

1787

"options": [ # The protocol buffer options.

1788

{ # A protocol buffer option, which can be attached to a message, field,

1789

# enumeration, etc.

1790

"name": "A String", # The option's name. For example, `"java_package"`.

1791

"value": { # The option's value. For example, `"com.google.protobuf"`.

1792

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

},

],

},

],

"logging": { # Logging configuration of the service. # Logging configuration of the service.

1799

#

1800

# The following example shows how to configure logs to be sent to the

1801

# producer and consumer projects. In the example,

1802

# the `library.googleapis.com/activity_history` log is

1803

# sent to both the producer and consumer projects, whereas

1804

# the `library.googleapis.com/purchase_history` log is only sent to the

1805

# producer project:

1806

#

1807

# monitored_resources:

1808

# - type: library.googleapis.com/branch

1809

# labels:

1810

# - key: /city

1811

# description: The city where the library branch is located in.

1812

# - key: /name

1813

# description: The name of the branch.

1814

# logs:

1815

# - name: library.googleapis.com/activity_history

1816

# labels:

1817

# - key: /customer_id

1818

# - name: library.googleapis.com/purchase_history

1819

# logging:

1820

# producer_destinations:

1821

# - monitored_resource: library.googleapis.com/branch

1822

# logs:

1823

# - library.googleapis.com/activity_history

1824

# - library.googleapis.com/purchase_history

1825

# consumer_destinations:

1826

# - monitored_resource: library.googleapis.com/branch

1827

# logs:

1828

# - library.googleapis.com/activity_history

1829

"producerDestinations": [ # Logging configurations for sending logs to the producer project.

1830

# There can be multiple producer destinations, each one must have a

1831

# different monitored resource type. A log can be used in at most

1832

# one producer destination.

1833

{ # Configuration of a specific logging destination (the producer project

1834

# or the consumer project).

1835

"monitoredResource": "A String", # The monitored resource type. The type must be defined in

1836

# Service.monitored_resources section.

1837

"logs": [ # Names of the logs to be sent to this destination. Each name must

1838

# be defined in the Service.logs section.

"A String",

],

},

],

"consumerDestinations": [ # Logging configurations for sending logs to the consumer project.

1844

# There can be multiple consumer destinations, each one must have a

1845

# different monitored resource type. A log can be used in at most

1846

# one consumer destination.

1847

{ # Configuration of a specific logging destination (the producer project

1848

# or the consumer project).

1849

"monitoredResource": "A String", # The monitored resource type. The type must be defined in

1850

# Service.monitored_resources section.

1851

"logs": [ # Names of the logs to be sent to this destination. Each name must

1852

# be defined in the Service.logs section.

"A String",

],

},

],

},

"name": "A String", # The DNS address at which this service is available,

1859

# e.g. `calendar.googleapis.com`.

1860

"documentation": { # `Documentation` provides the information for describing a service. # Additional API documentation.

1861

#

1862

# Example:

1863

# <pre><code>documentation:

1864

# summary: >

1865

# The Google Calendar API gives access

1866

# to most calendar features.

1867

# pages:

1868

# - name: Overview

1869

# content: (== include google/foo/overview.md ==)

1870

# - name: Tutorial

1871

# content: (== include google/foo/tutorial.md ==)

1872

# subpages;

1873

# - name: Java

1874

# content: (== include google/foo/tutorial_java.md ==)

1875

# rules:

1876

# - selector: google.calendar.Calendar.Get

1877

# description: >

1878

# ...

1879

# - selector: google.calendar.Calendar.Put

# description: >

# ...

# </code></pre>

# Documentation is provided in markdown syntax. In addition to

1884

# standard markdown features, definition lists, tables and fenced

1885

# code blocks are supported. Section headers can be provided and are

1886

# interpreted relative to the section nesting of the context where

1887

# a documentation fragment is embedded.

1888

#

1889

# Documentation from the IDL is merged with documentation defined

1890

# via the config at normalization time, where documentation provided

1891

# by config rules overrides IDL provided.

1892

#

1893

# A number of constructs specific to the API platform are supported

1894

# in documentation text.

1895

#

1896

# In order to reference a proto element, the following

1897

# notation can be used:

1898

# <pre><code>[fully.qualified.proto.name][]</code></pre>

1899

# To override the display text used for the link, this can be used:

1900

# <pre><code>[display text][fully.qualified.proto.name]</code></pre>

1901

# Text can be excluded from doc using the following notation:

1902

# <pre><code>(-- internal comment --)</code></pre>

1903

# Comments can be made conditional using a visibility label. The below

1904

# text will be only rendered if the `BETA` label is available:

1905

# <pre><code>(--BETA: comment for BETA users --)</code></pre>

1906

# A few directives are available in documentation. Note that

1907

# directives must appear on a single line to be properly

1908

# identified. The `include` directive includes a markdown file from

1909

# an external source:

1910

# <pre><code>(== include path/to/file ==)</code></pre>

1911

# The `resource_for` directive marks a message to be the resource of

1912

# a collection in REST view. If it is not specified, tools attempt

1913

# to infer the resource from the operations in a collection:

1914

# <pre><code>(== resource_for v1.shelves.books ==)</code></pre>

1915

# The directive `suppress_warning` does not directly affect documentation

1916

# and is documented together with service config validation.

1917

"rules": [ # A list of documentation rules that apply to individual API elements.

1918

#

1919

# **NOTE:** All service configuration rules follow "last one wins" order.

1920

{ # A documentation rule provides information about individual API elements.

1921

"description": "A String", # Description of the selected API(s).

1922

"deprecationDescription": "A String", # Deprecation description of the selected element(s). It can be provided if an

1923

# element is marked as `deprecated`.

1924

"selector": "A String", # The selector is a comma-separated list of patterns. Each pattern is a

1925

# qualified name of the element which may end in "*", indicating a wildcard.

1926

# Wildcards are only allowed at the end and for a whole component of the

1927

# qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". To

1928

# specify a default for all applicable elements, the whole pattern "*"

# is used.

},

],

"overview": "A String", # Declares a single overview page. For example:

1933

# <pre><code>documentation:

1934

# summary: ...

1935

# overview: (== include overview.md ==)

1936

# </code></pre>

1937

# This is a shortcut for the following declaration (using pages style):

1938

# <pre><code>documentation:

# summary: ...

# pages:

# - name: Overview

# content: (== include overview.md ==)

1943

# </code></pre>

1944

# Note: you cannot specify both `overview` field and `pages` field.

1945

"summary": "A String", # A short summary of what the service does. Can only be provided by

1946

# plain text.

1947

"pages": [ # The top level pages for the documentation set.

1948

{ # Represents a documentation page. A page can contain subpages to represent

1949

# nested documentation set structure.

1950

"content": "A String", # The Markdown content of the page. You can use <code>(== include {path} ==)</code>

1951

# to include content from a Markdown file.

1952

"subpages": [ # Subpages of this page. The order of subpages specified here will be

1953

# honored in the generated docset.

1954

# Object with schema name: Page

1955

],

1956

"name": "A String", # The name of the page. It will be used as an identity of the page to

1957

# generate URI of the page, text of the link to this page in navigation,

1958

# etc. The full page name (start from the root page name to this page

1959

# concatenated with `.`) can be used as reference to the page in your

1960

# documentation. For example:

1961

# <pre><code>pages:

1962

# - name: Tutorial

1963

# content: (== include tutorial.md ==)

1964

# subpages:

1965

# - name: Java

1966

# content: (== include tutorial_java.md ==)

1967

# </code></pre>

1968

# You can reference `Java` page using Markdown reference link syntax:

# `Java`.

},

],

"documentationRootUrl": "A String", # The URL to the root of documentation.

1973

},

1974

"systemTypes": [ # A list of all proto message types included in this API service.

1975

# It serves similar purpose as [google.api.Service.types], except that

1976

# these types are not needed by user-defined APIs. Therefore, they will not

1977

# show up in the generated discovery doc. This field should only be used

1978

# to define system APIs in ESF.

1979

{ # A protocol buffer message type.

1980

"oneofs": [ # The list of types appearing in `oneof` definitions in this type.

1981

"A String",

1982

],

1983

"name": "A String", # The fully qualified message name.

1984

"sourceContext": { # `SourceContext` represents information about the source of a # The source context.

1985

# protobuf element, like the file in which it is defined.

1986

"fileName": "A String", # The path-qualified name of the .proto file that contained the associated

1987

# protobuf element. For example: `"google/protobuf/source_context.proto"`.

1988

},

1989

"syntax": "A String", # The source syntax.

1990

"fields": [ # The list of fields.

1991

{ # A single field of a message type.

1992

"kind": "A String", # The field type.

1993

"oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration

1994

# types. The first type has index 1; zero means the type is not in the list.

1995

"typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration

1996

# types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.

1997

"name": "A String", # The field name.

1998

"defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.

1999

"jsonName": "A String", # The field JSON name.

2000

"number": 42, # The field number.

2001

"cardinality": "A String", # The field cardinality.

2002

"options": [ # The protocol buffer options.

2003

{ # A protocol buffer option, which can be attached to a message, field,

2004

# enumeration, etc.

2005

"name": "A String", # The option's name. For example, `"java_package"`.

2006

"value": { # The option's value. For example, `"com.google.protobuf"`.

2007

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

},

],

"packed": True or False, # Whether to use alternative packed wire representation.

2012

},

2013

],

2014

"options": [ # The protocol buffer options.

2015

{ # A protocol buffer option, which can be attached to a message, field,

2016

# enumeration, etc.

2017

"name": "A String", # The option's name. For example, `"java_package"`.

2018

"value": { # The option's value. For example, `"com.google.protobuf"`.

2019

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

},

],

},

],

"context": { # `Context` defines which contexts an API requests. # Context configuration.

#

# Example:

#

# context:

# rules:

# - selector: "*"

# requested:

# - google.rpc.context.ProjectContext

2034

# - google.rpc.context.OriginContext

2035

#

2036

# The above specifies that all methods in the API request

2037

# `google.rpc.context.ProjectContext` and

2038

# `google.rpc.context.OriginContext`.

2039

#

2040

# Available context types are defined in package

2041

# `google.rpc.context`.

2042

"rules": [ # A list of RPC context rules that apply to individual API methods.

2043

#

2044

# **NOTE:** All service configuration rules follow "last one wins" order.

2045

{ # A context rule provides information about the context for an individual API

2046

# element.

2047

"provided": [ # A list of full type names of provided contexts.

2048

"A String",

2049

],

2050

"requested": [ # A list of full type names of requested contexts.

2051

"A String",

2052

],

2053

"selector": "A String", # Selects the methods to which this rule applies.

2054

#

2055

# Refer to selector for syntax details.

},

],

},

}</pre>

</div>

<code class="details" id="getIamPolicy">getIamPolicy(resource=None, body, x__xgafv=None)</code>

2064

<pre>Gets the access control policy for a resource.

2065

Returns an empty policy if the resource exists and does not have a policy

set.

Args:

resource: string, REQUIRED: The resource for which the policy is being requested.

2070

`resource` is usually specified as a path. For example, a Project

2071

resource is specified as `projects/{project}`. (required)

2072

body: object, The request body. (required)

2073

The object takes the form of:

2074

2075

{ # Request message for `GetIamPolicy` method.

2076

}

2077

2078

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2085

2086

{ # Defines an Identity and Access Management (IAM) policy. It is used to

2087

# specify access control policies for Cloud Platform resources.

2088

#

2089

#

2090

# A `Policy` consists of a list of `bindings`. A `Binding` binds a list of

2091

# `members` to a `role`, where the members can be user accounts, Google groups,

2092

# Google domains, and service accounts. A `role` is a named list of permissions

# defined by IAM.

#

# **Example**

#

# {

# "bindings": [

# {

# "role": "roles/owner",

2101

# "members": [

2102

# "user:mike@example.com",

2103

# "group:admins@example.com",

2104

# "domain:google.com",

2105

# "serviceAccount:my-other-app@appspot.gserviceaccount.com",

# ]

# },

# {

# "role": "roles/viewer",

2110

# "members": ["user:sean@example.com"]

# }

# ]

# }

#

# For a description of IAM and its features, see the

2116

# [IAM developer's guide](https://cloud.google.com/iam).

2117

"auditConfigs": [ # Specifies audit logging configs for "data access".

2118

# "data access": generally refers to data reads/writes and admin reads.

2119

# "admin activity": generally refers to admin writes.

2120

#

2121

# Note: `AuditConfig` doesn't apply to "admin activity", which always

2122

# enables audit logging.

2123

{ # Enables "data access" audit logging for a service and specifies a list

2124

# of members that are log-exempted.

2125

"exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit

2126

# logging for the `service` specified above.

2127

# Follows the same format of Binding.members.

2128

"A String",

2129

],

2130

"service": "A String", # Specifies a service that will be enabled for "data access" audit

2131

# logging.

2132

# For example, `resourcemanager`, `storage`, `compute`.

2133

# `allServices` is a special value that covers all services.

2134

},

2135

],

2136

"rules": [ # If more than one rule is specified, the rules are applied in the following

2137

# manner:

2138

# - All matching LOG rules are always applied.

2139

# - If any DENY/DENY_WITH_LOG rule matches, permission is denied.

2140

# Logging will be applied if one or more matching rule requires logging.

2141

# - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is

2142

# granted.

2143

# Logging will be applied if one or more matching rule requires logging.

2144

# - Otherwise, if no rule applies, permission is denied.

2145

{ # A rule to be applied in a Policy.

2146

"notIn": [ # If one or more 'not_in' clauses are specified, the rule matches

2147

# if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

2148

# The format for in and not_in entries is the same as for members in a

2149

# Binding (see google/iam/v1/policy.proto).

2150

"A String",

2151

],

2152

"description": "A String", # Human-readable description of the rule.

2153

"in": [ # If one or more 'in' clauses are specified, the rule matches if

2154

# the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

2155

"A String",

2156

],

2157

"action": "A String", # Required

2158

"conditions": [ # Additional restrictions that must be met

2159

{ # A condition to be met.

2160

"iam": "A String", # Trusted attributes supplied by the IAM system.

2161

"svc": "A String", # Trusted attributes discharged by the service.

2162

"value": "A String", # DEPRECATED. Use 'values' instead.

2163

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses

2164

# the IAM system for access control.

2165

"values": [ # The objects of the condition. This is mutually exclusive with 'value'.

2166

"A String",

2167

],

2168

"op": "A String", # An operator to apply the subject with.

2169

},

2170

],

2171

"logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries

2172

# that match the LOG action.

2173

{ # Specifies what kind of log the caller must write

2174

# Increment a streamz counter with the specified metric and field names.

2175

#

2176

# Metric names should start with a '/', generally be lowercase-only,

2177

# and end in "_count". Field names should not contain an initial slash.

2178

# The actual exported metric names will have "/iam/policy" prepended.

2179

#

2180

# Field names correspond to IAM request parameters and field values are

2181

# their respective values.

2182

#

2183

# At present the only supported field names are

2184

# - "iam_principal", corresponding to IAMContext.principal;

2185

# - "" (empty string), resulting in one aggretated counter with no field.

2186

#

2187

# Examples:

2188

# counter { metric: "/debug_access_count" field: "iam_principal" }

2189

# ==> increment counter /iam/policy/backend_debug_access_count

2190

# {iam_principal=[value of IAMContext.principal]}

2191

#

2192

# At this time we do not support:

2193

# * multiple field names (though this may be supported in the future)

2194

# * decrementing the counter

2195

# * incrementing it by anything other than 1

2196

"counter": { # Options for counters # Counter options.

2197

"field": "A String", # The field value to attribute.

2198

"metric": "A String", # The metric to update.

2199

},

2200

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

2201

},

2202

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

},

},

],

"permissions": [ # A permission is a string of form '<service>.<resource type>.<verb>'

2207

# (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,

2208

# and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Version of the `Policy`. The default version is 0.

2214

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

2215

# prevent simultaneous updates of a policy from overwriting each other.

2216

# It is strongly suggested that systems make use of the `etag` in the

2217

# read-modify-write cycle to perform policy updates in order to avoid race

2218

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

2219

# systems are expected to put that etag in the request to `setIamPolicy` to

2220

# ensure that their change will be applied to the same version of the policy.

2221

#

2222

# If no `etag` is provided in the call to `setIamPolicy`, then the existing

2223

# policy is overwritten blindly.

2224

"bindings": [ # Associates a list of `members` to a `role`.

2225

# Multiple `bindings` must not be specified for the same `role`.

2226

# `bindings` with no members will result in an error.

2227

{ # Associates `members` with a `role`.

2228

"role": "A String", # Role that is assigned to `members`.

2229

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

2230

# Required

2231

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

2232

# `members` can have the following values:

2233

#

2234

# * `allUsers`: A special identifier that represents anyone who is

2235

# on the internet; with or without a Google account.

2236

#

2237

# * `allAuthenticatedUsers`: A special identifier that represents anyone

2238

# who is authenticated with a Google account or a service account.

2239

#

2240

# * `user:{emailid}`: An email address that represents a specific Google

2241

# account. For example, `alice@gmail.com` or `joe@example.com`.

2242

#

2243

# * `serviceAccount:{emailid}`: An email address that represents a service

2244

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

2245

#

2246

# * `group:{emailid}`: An email address that represents a Google group.

2247

# For example, `admins@example.com`.

2248

#

2249

# * `domain:{domain}`: A Google Apps domain name that represents all the

2250

# users of that domain. For example, `google.com` or `example.com`.

#

"A String",

],

},

],

"iamOwned": True or False,

}</pre>

</div>

<code class="details" id="list">list(producerProjectId=None, pageSize=None, pageToken=None, x__xgafv=None)</code>

2262

<pre>Lists all managed services.

2263

2264

Args:

2265

producerProjectId: string, Include services produced by the specified project.

2266

pageSize: integer, Requested size of the next page of data.

2267

pageToken: string, Token identifying which result to start with; returned by a previous list

2268

call.

2269

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2276

2277

{ # Response message for `ListServices` method.

2278

"nextPageToken": "A String", # Token that can be passed to `ListServices` to resume a paginated query.

2279

"services": [ # The results of the query.

2280

{ # The full representation of a Service that is managed by

2281

# Google Service Management.

2282

"serviceName": "A String", # The name of the service. See the [overview](/service-management/overview)

2283

# for naming requirements.

2284

"producerProjectId": "A String", # ID of the project that produces and owns this service.

},

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

2292

<pre>Retrieves the next page of results.

2293

2294

Args:

2295

previous_request: The request for the previous page. (required)

2296

previous_response: The response from the request for the previous page. (required)

2297

2298

Returns:

2299

A request object that you can call 'execute()' on to request the next

2300

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="setIamPolicy">setIamPolicy(resource=None, body, x__xgafv=None)</code>

2306

<pre>Sets the access control policy on the specified resource. Replaces any

existing policy.

Args:

resource: string, REQUIRED: The resource for which the policy is being specified.

2311

`resource` is usually specified as a path. For example, a Project

2312

resource is specified as `projects/{project}`. (required)

2313

body: object, The request body. (required)

2314

The object takes the form of:

2315

2316

{ # Request message for `SetIamPolicy` method.

2317

"policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # REQUIRED: The complete policy to be applied to the `resource`. The size of

2318

# the policy is limited to a few 10s of KB. An empty policy is a

2319

# valid policy but certain Cloud Platform services (such as Projects)

2320

# might reject them.

2321

# specify access control policies for Cloud Platform resources.

2322

#

2323

#

2324

# A `Policy` consists of a list of `bindings`. A `Binding` binds a list of

2325

# `members` to a `role`, where the members can be user accounts, Google groups,

2326

# Google domains, and service accounts. A `role` is a named list of permissions

# defined by IAM.

#

# **Example**

#

# {

# "bindings": [

# {

# "role": "roles/owner",

2335

# "members": [

2336

# "user:mike@example.com",

2337

# "group:admins@example.com",

2338

# "domain:google.com",

2339

# "serviceAccount:my-other-app@appspot.gserviceaccount.com",

# ]

# },

# {

# "role": "roles/viewer",

2344

# "members": ["user:sean@example.com"]

# }

# ]

# }

#

# For a description of IAM and its features, see the

2350

# [IAM developer's guide](https://cloud.google.com/iam).

2351

"auditConfigs": [ # Specifies audit logging configs for "data access".

2352

# "data access": generally refers to data reads/writes and admin reads.

2353

# "admin activity": generally refers to admin writes.

2354

#

2355

# Note: `AuditConfig` doesn't apply to "admin activity", which always

2356

# enables audit logging.

2357

{ # Enables "data access" audit logging for a service and specifies a list

2358

# of members that are log-exempted.

2359

"exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit

2360

# logging for the `service` specified above.

2361

# Follows the same format of Binding.members.

2362

"A String",

2363

],

2364

"service": "A String", # Specifies a service that will be enabled for "data access" audit

2365

# logging.

2366

# For example, `resourcemanager`, `storage`, `compute`.

2367

# `allServices` is a special value that covers all services.

2368

},

2369

],

2370

"rules": [ # If more than one rule is specified, the rules are applied in the following

2371

# manner:

2372

# - All matching LOG rules are always applied.

2373

# - If any DENY/DENY_WITH_LOG rule matches, permission is denied.

2374

# Logging will be applied if one or more matching rule requires logging.

2375

# - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is

2376

# granted.

2377

# Logging will be applied if one or more matching rule requires logging.

2378

# - Otherwise, if no rule applies, permission is denied.

2379

{ # A rule to be applied in a Policy.

2380

"notIn": [ # If one or more 'not_in' clauses are specified, the rule matches

2381

# if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

2382

# The format for in and not_in entries is the same as for members in a

2383

# Binding (see google/iam/v1/policy.proto).

2384

"A String",

2385

],

2386

"description": "A String", # Human-readable description of the rule.

2387

"in": [ # If one or more 'in' clauses are specified, the rule matches if

2388

# the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

2389

"A String",

2390

],

2391

"action": "A String", # Required

2392

"conditions": [ # Additional restrictions that must be met

2393

{ # A condition to be met.

2394

"iam": "A String", # Trusted attributes supplied by the IAM system.

2395

"svc": "A String", # Trusted attributes discharged by the service.

2396

"value": "A String", # DEPRECATED. Use 'values' instead.

2397

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses

2398

# the IAM system for access control.

2399

"values": [ # The objects of the condition. This is mutually exclusive with 'value'.

2400

"A String",

2401

],

2402

"op": "A String", # An operator to apply the subject with.

2403

},

2404

],

2405

"logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries

2406

# that match the LOG action.

2407

{ # Specifies what kind of log the caller must write

2408

# Increment a streamz counter with the specified metric and field names.

2409

#

2410

# Metric names should start with a '/', generally be lowercase-only,

2411

# and end in "_count". Field names should not contain an initial slash.

2412

# The actual exported metric names will have "/iam/policy" prepended.

2413

#

2414

# Field names correspond to IAM request parameters and field values are

2415

# their respective values.

2416

#

2417

# At present the only supported field names are

2418

# - "iam_principal", corresponding to IAMContext.principal;

2419

# - "" (empty string), resulting in one aggretated counter with no field.

2420

#

2421

# Examples:

2422

# counter { metric: "/debug_access_count" field: "iam_principal" }

2423

# ==> increment counter /iam/policy/backend_debug_access_count

2424

# {iam_principal=[value of IAMContext.principal]}

2425

#

2426

# At this time we do not support:

2427

# * multiple field names (though this may be supported in the future)

2428

# * decrementing the counter

2429

# * incrementing it by anything other than 1

2430

"counter": { # Options for counters # Counter options.

2431

"field": "A String", # The field value to attribute.

2432

"metric": "A String", # The metric to update.

2433

},

2434

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

2435

},

2436

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

},

},

],

"permissions": [ # A permission is a string of form '<service>.<resource type>.<verb>'

2441

# (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,

2442

# and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Version of the `Policy`. The default version is 0.

2448

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

2449

# prevent simultaneous updates of a policy from overwriting each other.

2450

# It is strongly suggested that systems make use of the `etag` in the

2451

# read-modify-write cycle to perform policy updates in order to avoid race

2452

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

2453

# systems are expected to put that etag in the request to `setIamPolicy` to

2454

# ensure that their change will be applied to the same version of the policy.

2455

#

2456

# If no `etag` is provided in the call to `setIamPolicy`, then the existing

2457

# policy is overwritten blindly.

2458

"bindings": [ # Associates a list of `members` to a `role`.

2459

# Multiple `bindings` must not be specified for the same `role`.

2460

# `bindings` with no members will result in an error.

2461

{ # Associates `members` with a `role`.

2462

"role": "A String", # Role that is assigned to `members`.

2463

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

2464

# Required

2465

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

2466

# `members` can have the following values:

2467

#

2468

# * `allUsers`: A special identifier that represents anyone who is

2469

# on the internet; with or without a Google account.

2470

#

2471

# * `allAuthenticatedUsers`: A special identifier that represents anyone

2472

# who is authenticated with a Google account or a service account.

2473

#

2474

# * `user:{emailid}`: An email address that represents a specific Google

2475

# account. For example, `alice@gmail.com` or `joe@example.com`.

2476

#

2477

# * `serviceAccount:{emailid}`: An email address that represents a service

2478

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

2479

#

2480

# * `group:{emailid}`: An email address that represents a Google group.

2481

# For example, `admins@example.com`.

2482

#

2483

# * `domain:{domain}`: A Google Apps domain name that represents all the

2484

# users of that domain. For example, `google.com` or `example.com`.

#

"A String",

],

},

],

"iamOwned": True or False,

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2501

2502

{ # Defines an Identity and Access Management (IAM) policy. It is used to

2503

# specify access control policies for Cloud Platform resources.

2504

#

2505

#

2506

# A `Policy` consists of a list of `bindings`. A `Binding` binds a list of

2507

# `members` to a `role`, where the members can be user accounts, Google groups,

2508

# Google domains, and service accounts. A `role` is a named list of permissions

# defined by IAM.

#

# **Example**

#

# {

# "bindings": [

# {

# "role": "roles/owner",

2517

# "members": [

2518

# "user:mike@example.com",

2519

# "group:admins@example.com",

2520

# "domain:google.com",

2521

# "serviceAccount:my-other-app@appspot.gserviceaccount.com",

# ]

# },

# {

# "role": "roles/viewer",

2526

# "members": ["user:sean@example.com"]

# }

# ]

# }

#

# For a description of IAM and its features, see the

2532

# [IAM developer's guide](https://cloud.google.com/iam).

2533

"auditConfigs": [ # Specifies audit logging configs for "data access".

2534

# "data access": generally refers to data reads/writes and admin reads.

2535

# "admin activity": generally refers to admin writes.

2536

#

2537

# Note: `AuditConfig` doesn't apply to "admin activity", which always

2538

# enables audit logging.

2539

{ # Enables "data access" audit logging for a service and specifies a list

2540

# of members that are log-exempted.

2541

"exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit

2542

# logging for the `service` specified above.

2543

# Follows the same format of Binding.members.

2544

"A String",

2545

],

2546

"service": "A String", # Specifies a service that will be enabled for "data access" audit

2547

# logging.

2548

# For example, `resourcemanager`, `storage`, `compute`.

2549

# `allServices` is a special value that covers all services.

2550

},

2551

],

2552

"rules": [ # If more than one rule is specified, the rules are applied in the following

2553

# manner:

2554

# - All matching LOG rules are always applied.

2555

# - If any DENY/DENY_WITH_LOG rule matches, permission is denied.

2556

# Logging will be applied if one or more matching rule requires logging.

2557

# - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is

2558

# granted.

2559

# Logging will be applied if one or more matching rule requires logging.

2560

# - Otherwise, if no rule applies, permission is denied.

2561

{ # A rule to be applied in a Policy.

2562

"notIn": [ # If one or more 'not_in' clauses are specified, the rule matches

2563

# if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

2564

# The format for in and not_in entries is the same as for members in a

2565

# Binding (see google/iam/v1/policy.proto).

2566

"A String",

2567

],

2568

"description": "A String", # Human-readable description of the rule.

2569

"in": [ # If one or more 'in' clauses are specified, the rule matches if

2570

# the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

2571

"A String",

2572

],

2573

"action": "A String", # Required

2574

"conditions": [ # Additional restrictions that must be met

2575

{ # A condition to be met.

2576

"iam": "A String", # Trusted attributes supplied by the IAM system.

2577

"svc": "A String", # Trusted attributes discharged by the service.

2578

"value": "A String", # DEPRECATED. Use 'values' instead.

2579

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses

2580

# the IAM system for access control.

2581

"values": [ # The objects of the condition. This is mutually exclusive with 'value'.

2582

"A String",

2583

],

2584

"op": "A String", # An operator to apply the subject with.

2585

},

2586

],

2587

"logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries

2588

# that match the LOG action.

2589

{ # Specifies what kind of log the caller must write

2590

# Increment a streamz counter with the specified metric and field names.

2591

#

2592

# Metric names should start with a '/', generally be lowercase-only,

2593

# and end in "_count". Field names should not contain an initial slash.

2594

# The actual exported metric names will have "/iam/policy" prepended.

2595

#

2596

# Field names correspond to IAM request parameters and field values are

2597

# their respective values.

2598

#

2599

# At present the only supported field names are

2600

# - "iam_principal", corresponding to IAMContext.principal;

2601

# - "" (empty string), resulting in one aggretated counter with no field.

2602

#

2603

# Examples:

2604

# counter { metric: "/debug_access_count" field: "iam_principal" }

2605

# ==> increment counter /iam/policy/backend_debug_access_count

2606

# {iam_principal=[value of IAMContext.principal]}

2607

#

2608

# At this time we do not support:

2609

# * multiple field names (though this may be supported in the future)

2610

# * decrementing the counter

2611

# * incrementing it by anything other than 1

2612

"counter": { # Options for counters # Counter options.

2613

"field": "A String", # The field value to attribute.

2614

"metric": "A String", # The metric to update.

2615

},

2616

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

2617

},

2618

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

},

},

],

"permissions": [ # A permission is a string of form '<service>.<resource type>.<verb>'

2623

# (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,

2624

# and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Version of the `Policy`. The default version is 0.

2630

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

2631

# prevent simultaneous updates of a policy from overwriting each other.

2632

# It is strongly suggested that systems make use of the `etag` in the

2633

# read-modify-write cycle to perform policy updates in order to avoid race

2634

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

2635

# systems are expected to put that etag in the request to `setIamPolicy` to

2636

# ensure that their change will be applied to the same version of the policy.

2637

#

2638

# If no `etag` is provided in the call to `setIamPolicy`, then the existing

2639

# policy is overwritten blindly.

2640

"bindings": [ # Associates a list of `members` to a `role`.

2641

# Multiple `bindings` must not be specified for the same `role`.

2642

# `bindings` with no members will result in an error.

2643

{ # Associates `members` with a `role`.

2644

"role": "A String", # Role that is assigned to `members`.

2645

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

2646

# Required

2647

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

2648

# `members` can have the following values:

2649

#

2650

# * `allUsers`: A special identifier that represents anyone who is

2651

# on the internet; with or without a Google account.

2652

#

2653

# * `allAuthenticatedUsers`: A special identifier that represents anyone

2654

# who is authenticated with a Google account or a service account.

2655

#

2656

# * `user:{emailid}`: An email address that represents a specific Google

2657

# account. For example, `alice@gmail.com` or `joe@example.com`.

2658

#

2659

# * `serviceAccount:{emailid}`: An email address that represents a service

2660

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

2661

#

2662

# * `group:{emailid}`: An email address that represents a Google group.

2663

# For example, `admins@example.com`.

2664

#

2665

# * `domain:{domain}`: A Google Apps domain name that represents all the

2666

# users of that domain. For example, `google.com` or `example.com`.

#

"A String",

],

},

],

"iamOwned": True or False,

}</pre>

</div>

<code class="details" id="testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</code>

2678

<pre>Returns permissions that a caller has on the specified resource.

2679

2680

Args:

2681

resource: string, REQUIRED: The resource for which the policy detail is being requested.

2682

`resource` is usually specified as a path. For example, a Project

2683

resource is specified as `projects/{project}`. (required)

2684

body: object, The request body. (required)

2685

The object takes the form of:

2686

2687

{ # Request message for `TestIamPermissions` method.

2688

"permissions": [ # The set of permissions to check for the `resource`. Permissions with

2689

# wildcards (such as '*' or 'storage.*') are not allowed. For more

2690

# information see

2691

# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

"A String",

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2703

2704

{ # Response message for `TestIamPermissions` method.

2705

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is

# allowed.

"A String",

],

}</pre>

</div>

<code class="details" id="undelete">undelete(serviceName=None, x__xgafv=None)</code>

2714

<pre>Revives a previously deleted managed service. The method restores the

2715

service using the configuration at the time the service was deleted.

2716

The target service must exist and must have been deleted within the

2717

last 30 days.

2718

2719

Operation<response: UndeleteServiceResponse>

2720

2721

Args:

2722

serviceName: string, The name of the service. See the [overview](/service-management/overview)

2723

for naming requirements. For example: `example.googleapis.com`. (required)

2724

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2731

2732

{ # This resource represents a long-running operation that is the result of a

2733

# network API call.

2734

"metadata": { # Service-specific metadata associated with the operation. It typically

2735

# contains progress information and common metadata such as create time.

2736

# Some services might not provide such metadata. Any method that returns a

2737

# long-running operation should document the metadata type, if any.

2738

"a_key": "", # Properties of the object. Contains field @type with type URL.

2739

},

2740

"done": True or False, # If the value is `false`, it means the operation is still in progress.

2741

# If true, the operation is completed, and either `error` or `response` is

2742

# available.

2743

"response": { # The normal response of the operation in case of success. If the original

2744

# method returns no data on success, such as `Delete`, the response is

2745

# `google.protobuf.Empty`. If the original method is standard

2746

# `Get`/`Create`/`Update`, the response should be the resource. For other

2747

# methods, the response should have the type `XxxResponse`, where `Xxx`

2748

# is the original method name. For example, if the original method name

2749

# is `TakeSnapshot()`, the inferred response type is

2750

# `TakeSnapshotResponse`.

2751

"a_key": "", # Properties of the object. Contains field @type with type URL.

2752

},

2753

"name": "A String", # The server-assigned name, which is only unique within the same service that

2754

# originally returns it. If you use the default HTTP mapping, the

2755

# `name` should have the format of `operations/some/unique/name`.

2756

"error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.

2757

# programming environments, including REST APIs and RPC APIs. It is used by

2758

# [gRPC](https://github.com/grpc). The error model is designed to be:

2759

#

2760

# - Simple to use and understand for most users

2761

# - Flexible enough to meet unexpected needs

#

# # Overview

#

# The `Status` message contains three pieces of data: error code, error message,

2766

# and error details. The error code should be an enum value of

2767

# google.rpc.Code, but it may accept additional error codes if needed. The

2768

# error message should be a developer-facing English message that helps

2769

# developers *understand* and *resolve* the error. If a localized user-facing

2770

# error message is needed, put the localized message in the error details or

2771

# localize it in the client. The optional error details may contain arbitrary

2772

# information about the error. There is a predefined set of error detail types

2773

# in the package `google.rpc` which can be used for common error conditions.

#

# # Language mapping

#

# The `Status` message is the logical representation of the error model, but it

2778

# is not necessarily the actual wire format. When the `Status` message is

2779

# exposed in different client libraries and different wire protocols, it can be

2780

# mapped differently. For example, it will likely be mapped to some exceptions

2781

# in Java, but more likely mapped to some error codes in C.

#

# # Other uses

#

# The error model and the `Status` message can be used in a variety of

2786

# environments, either with or without APIs, to provide a

2787

# consistent developer experience across different environments.

2788

#

2789

# Example uses of this error model include:

2790

#

2791

# - Partial errors. If a service needs to return partial errors to the client,

2792

# it may embed the `Status` in the normal response to indicate the partial

2793

# errors.

2794

#

2795

# - Workflow errors. A typical workflow has multiple steps. Each step may

2796

# have a `Status` message for error reporting purpose.

2797

#

2798

# - Batch operations. If a client uses batch request and batch response, the

2799

# `Status` message should be used directly inside batch response, one for

2800

# each error sub-response.

2801

#

2802

# - Asynchronous operations. If an API call embeds asynchronous operation

2803

# results in its response, the status of those operations should be

2804

# represented directly using the `Status` message.

2805

#

2806

# - Logging. If some API errors are stored in logs, the message `Status` could

2807

# be used directly after any stripping needed for security/privacy reasons.

2808

"message": "A String", # A developer-facing error message, which should be in English. Any

2809

# user-facing error message should be localized and sent in the

2810

# google.rpc.Status.details field, or localized by the client.

2811

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2812

"details": [ # A list of messages that carry the error details. There will be a

2813

# common set of message types for APIs to use.

2814

{

2815

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

],

},

}</pre>

</div>

</body></html>